/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you under the Apache License, Version 2.0 (the
 *  "License"); you may not use this file except in compliance
 *  with the License.  You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing,
 *  software distributed under the License is distributed on an
 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations
 *  under the License.
 */
package org.codehaus.groovy.tools.shell.completion

import org.codehaus.groovy.antlr.GroovySourceToken

/**
 * Interface for classes that complete identifier tokens within a groovy Statement
 * (Class, variable, keyword, method, ...)
 * Similar to JLine Completor, but adapted for usage in GroovySyntaxCompletor
 */
interface IdentifierCompletor {

    /**
     *
     * @param tokens List of tokens, non empty, last token is an identifier token, previous token is not a dot
     * @param candidates
     * @return
     */
    boolean complete(List<GroovySourceToken> tokens, List<CharSequence> candidates)

}
